<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::session::Server_app Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1session.html">session</a></li><li class="navelem"><a class="el" href="structipc_1_1session_1_1Server__app.html">Server_app</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="structipc_1_1session_1_1Server__app-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::session::Server_app Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> that is used as a server in at least one client-server IPC split.  
 <a href="structipc_1_1session_1_1Server__app.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="app_8hpp_source.html">app.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ipc::session::Server_app:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1session_1_1Server__app__inherit__graph.svg" width="168" height="107"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ipc::session::Server_app:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1session_1_1Server__app__coll__graph.svg" width="608" height="312"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1fc9e403e3b5c89a4cd328da829590a4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__app.html#a1fc9e403e3b5c89a4cd328da829590a4">Master_set</a> = boost::unordered_map&lt; std::string, <a class="el" href="structipc_1_1session_1_1Server__app.html">Server_app</a> &gt;</td></tr>
<tr class="memdesc:a1fc9e403e3b5c89a4cd328da829590a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suggested type for storing master repository or all <code>Server_apps</code>s. See <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header for discussion.  <a href="structipc_1_1session_1_1Server__app.html#a1fc9e403e3b5c89a4cd328da829590a4">More...</a><br /></td></tr>
<tr class="separator:a1fc9e403e3b5c89a4cd328da829590a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268ca127637100ab10a4ac296aff4fad"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__app.html#a268ca127637100ab10a4ac296aff4fad">Client_app_set</a> = boost::unordered_set&lt; std::string &gt;</td></tr>
<tr class="memdesc:a268ca127637100ab10a4ac296aff4fad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for existence-checkable set of <code><a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a></code>s via <a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd" title="Brief application name, readable to humans and unique across all other applications&#39; names; used both...">App::m_name</a>.  <a href="structipc_1_1session_1_1Server__app.html#a268ca127637100ab10a4ac296aff4fad">More...</a><br /></td></tr>
<tr class="separator:a268ca127637100ab10a4ac296aff4fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structipc_1_1session_1_1App"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structipc_1_1session_1_1App')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structipc_1_1session_1_1App.html">ipc::session::App</a></td></tr>
<tr class="memitem:af7527bc1ad0cde62cd4fde97bc1d7ecc inherit pub_types_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#af7527bc1ad0cde62cd4fde97bc1d7ecc">Master_set</a> = boost::unordered_map&lt; std::string, <a class="el" href="structipc_1_1session_1_1App.html">App</a> &gt;</td></tr>
<tr class="memdesc:af7527bc1ad0cde62cd4fde97bc1d7ecc inherit pub_types_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suggested type for storing master repository or all <code>Apps</code>s. See <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header for discussion.  <a href="structipc_1_1session_1_1App.html#af7527bc1ad0cde62cd4fde97bc1d7ecc">More...</a><br /></td></tr>
<tr class="separator:af7527bc1ad0cde62cd4fde97bc1d7ecc inherit pub_types_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a12df649b33893270afeac7240a571633"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structipc_1_1session_1_1Server__app.html#a268ca127637100ab10a4ac296aff4fad">Client_app_set</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__app.html#a12df649b33893270afeac7240a571633">m_allowed_client_apps</a></td></tr>
<tr class="memdesc:a12df649b33893270afeac7240a571633"><td class="mdescLeft">&#160;</td><td class="mdescRight">A given <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a> (as identified by its distinct <a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd" title="Brief application name, readable to humans and unique across all other applications&#39; names; used both...">App::m_name</a>) may request to establish an IPC session with an instance of <code>*this</code> <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a> as the conversation partner process if and only if it is in this set.  <a href="structipc_1_1session_1_1Server__app.html#a12df649b33893270afeac7240a571633">More...</a><br /></td></tr>
<tr class="separator:a12df649b33893270afeac7240a571633"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fa3317f8c57042789940be94f872500"><td class="memItemLeft" align="right" valign="top">fs::path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__app.html#a4fa3317f8c57042789940be94f872500">m_kernel_persistent_run_dir_override</a></td></tr>
<tr class="memdesc:a4fa3317f8c57042789940be94f872500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute path to the directory (without trailing separator) in the file system where kernel-persistent runtime, but not temporary, information shall be placed for this particular application; leave empty to use the default system path instead.  <a href="structipc_1_1session_1_1Server__app.html#a4fa3317f8c57042789940be94f872500">More...</a><br /></td></tr>
<tr class="separator:a4fa3317f8c57042789940be94f872500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdcd9e8b0287f914496d45a99848be44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705d">util::Permissions_level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__app.html#abdcd9e8b0287f914496d45a99848be44">m_permissions_level_for_client_apps</a></td></tr>
<tr class="memdesc:abdcd9e8b0287f914496d45a99848be44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies level of access for <code><a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a></code>s (which must, also, be in <a class="el" href="structipc_1_1session_1_1Server__app.html#a12df649b33893270afeac7240a571633" title="A given Client_app (as identified by its distinct App::m_name) may request to establish an IPC sessio...">m_allowed_client_apps</a> at any rate) as enforced by file system permissions.  <a href="structipc_1_1session_1_1Server__app.html#abdcd9e8b0287f914496d45a99848be44">More...</a><br /></td></tr>
<tr class="separator:abdcd9e8b0287f914496d45a99848be44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structipc_1_1session_1_1App"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structipc_1_1session_1_1App')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structipc_1_1session_1_1App.html">ipc::session::App</a></td></tr>
<tr class="memitem:a8e67b57829fe43a122a23c699b5de8fd inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd">m_name</a></td></tr>
<tr class="memdesc:a8e67b57829fe43a122a23c699b5de8fd inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brief application name, readable to humans and unique across all other applications' names; used both as a short programmatic key in shared resource naming (including as a folder in <a class="el" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea" title="Convenience alias for the commonly used type util::Shared_name.">Shared_name</a> for kernel-persistent resources and addresses; and in path names &ndash; such as PID file name &ndash; in the file system).  <a href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd">More...</a><br /></td></tr>
<tr class="separator:a8e67b57829fe43a122a23c699b5de8fd inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae82a8635858664720c8546e468f8090b inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">fs::path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#ae82a8635858664720c8546e468f8090b">m_exec_path</a></td></tr>
<tr class="memdesc:ae82a8635858664720c8546e468f8090b inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute, lexically normalized canonical path to the executable entity (which is not a directory), as it would appear in a command line or <code>exec()</code>-like invocation when actually invoking the application.  <a href="structipc_1_1session_1_1App.html#ae82a8635858664720c8546e468f8090b">More...</a><br /></td></tr>
<tr class="separator:ae82a8635858664720c8546e468f8090b inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e32297579603f2d96616976474d0246 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc_1_1util.html#a6435c1b48ec8684c24ca406d1d17208e">util::user_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">m_user_id</a></td></tr>
<tr class="memdesc:a9e32297579603f2d96616976474d0246 inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">The application must run as this user ID (UID). Files and other shared resources shall have this owner.  <a href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">More...</a><br /></td></tr>
<tr class="separator:a9e32297579603f2d96616976474d0246 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78bb1e984835f429fd44869a83f4b093 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc_1_1util.html#a3f7d069ce0d23f73153da2e2559dc3d3">util::group_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">m_group_id</a></td></tr>
<tr class="memdesc:a78bb1e984835f429fd44869a83f4b093 inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">The application must run as this group ID (GID). Files and other shared resources shall have this owner.  <a href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">More...</a><br /></td></tr>
<tr class="separator:a78bb1e984835f429fd44869a83f4b093 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p >(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a34a03a25908100446b3eca2e8dca61fe"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__app.html#a34a03a25908100446b3eca2e8dca61fe">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structipc_1_1session_1_1Server__app.html">Server_app</a> &amp;val)</td></tr>
<tr class="memdesc:a34a03a25908100446b3eca2e8dca61fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a></code> to the given <code>ostream</code>.  <a href="structipc_1_1session_1_1Server__app.html#a34a03a25908100446b3eca2e8dca61fe">More...</a><br /></td></tr>
<tr class="separator:a34a03a25908100446b3eca2e8dca61fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header related_structipc_1_1session_1_1App"><td colspan="2" onclick="javascript:toggleInherit('related_structipc_1_1session_1_1App')"><img src="closed.png" alt="-"/>&#160;Related Functions inherited from <a class="el" href="structipc_1_1session_1_1App.html">ipc::session::App</a></td></tr>
<tr class="memitem:a6b2f9a90ac9cc5098d9b90e7f547c97e inherit related_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structipc_1_1session_1_1App.html">App</a> &amp;val)</td></tr>
<tr class="memdesc:a6b2f9a90ac9cc5098d9b90e7f547c97e inherit related_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a></code> to the given <code>ostream</code>.  <a href="structipc_1_1session_1_1App.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">More...</a><br /></td></tr>
<tr class="separator:a6b2f9a90ac9cc5098d9b90e7f547c97e inherit related_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >An <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> that is used as a server in at least one client-server IPC split. </p>
<p >This is explained in the "App, Client_app, Server_app registry conventions" section of the <code>struct</code> <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header.</p>
<dl class="section see"><dt>See also</dt><dd><code>struct</code> <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header.</dd></dl>
<p>As explained there, each <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a> &ndash; in addition to the source <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> fields copied from an <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> in the master <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> repository &ndash; ultimately stores references (by <a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd" title="Brief application name, readable to humans and unique across all other applications&#39; names; used both...">App::m_name</a>) to the <code><a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a></code>s describing client apps that may initiate sessions with that <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a>. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00205">205</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a268ca127637100ab10a4ac296aff4fad" name="a268ca127637100ab10a4ac296aff4fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a268ca127637100ab10a4ac296aff4fad">&#9670;&nbsp;</a></span>Client_app_set</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1session_1_1Server__app.html#a268ca127637100ab10a4ac296aff4fad">ipc::session::Server_app::Client_app_set</a> =  boost::unordered_set&lt;std::string&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Short-hand for existence-checkable set of <code><a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a></code>s via <a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd" title="Brief application name, readable to humans and unique across all other applications&#39; names; used both...">App::m_name</a>. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00213">213</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

</div>
</div>
<a id="a1fc9e403e3b5c89a4cd328da829590a4" name="a1fc9e403e3b5c89a4cd328da829590a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fc9e403e3b5c89a4cd328da829590a4">&#9670;&nbsp;</a></span>Master_set</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1session_1_1Server__app.html#a1fc9e403e3b5c89a4cd328da829590a4">ipc::session::Server_app::Master_set</a> =  boost::unordered_map&lt;std::string, <a class="el" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Suggested type for storing master repository or all <code>Server_apps</code>s. See <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header for discussion. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00210">210</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a34a03a25908100446b3eca2e8dca61fe" name="a34a03a25908100446b3eca2e8dca61fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34a03a25908100446b3eca2e8dca61fe">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structipc_1_1session_1_1Server__app.html">Server_app</a> &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prints string representation of the given <code><a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a></code> to the given <code>ostream</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to write. </td></tr>
    <tr><td class="paramname">val</td><td>Object to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="app_8cpp_source.html#l00134">134</a> of file <a class="el" href="app_8cpp_source.html">app.cpp</a>.</p>

<p class="reference">References <a class="el" href="app_8hpp_source.html#l00222">m_allowed_client_apps</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a12df649b33893270afeac7240a571633" name="a12df649b33893270afeac7240a571633"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12df649b33893270afeac7240a571633">&#9670;&nbsp;</a></span>m_allowed_client_apps</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structipc_1_1session_1_1Server__app.html#a268ca127637100ab10a4ac296aff4fad">Client_app_set</a> ipc::session::Server_app::m_allowed_client_apps</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A given <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a> (as identified by its distinct <a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd" title="Brief application name, readable to humans and unique across all other applications&#39; names; used both...">App::m_name</a>) may request to establish an IPC session with an instance of <code>*this</code> <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a> as the conversation partner process if and only if it is in this set. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00222">222</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

<p class="reference">Referenced by <a class="el" href="app_8cpp_source.html#l00134">operator&lt;&lt;()</a>.</p>

</div>
</div>
<a id="a4fa3317f8c57042789940be94f872500" name="a4fa3317f8c57042789940be94f872500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fa3317f8c57042789940be94f872500">&#9670;&nbsp;</a></span>m_kernel_persistent_run_dir_override</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">fs::path ipc::session::Server_app::m_kernel_persistent_run_dir_override</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Absolute path to the directory (without trailing separator) in the file system where kernel-persistent runtime, but not temporary, information shall be placed for this particular application; leave empty to use the default system path instead. </p>
<p >Informally: In production it is recommended to leave this empty, as the default system path is a well known location (namely /var/run) where one would expect to find such files.</p>
<p >Kernel-persistent means that it'll disappear at reboot; runtime, but not temporary, means it's... not a thing that might be wiped spuriously anytime (informally: not /tmp). Informally: just know that it is normally /var/run, and that it stores things such as process-ID (PID) files.</p>
<p >It shall be a Unix path and absolute (starts with forward-slash) (and lacks a root-name). Informally it is probably best for it to be lexically normal as well.</p>
<h3>Rationale</h3>
<p >Why allow this override, if the default is sensible? Answer: The default usually requires admin privileges for writing. For test/debug purposes a location like /tmp or /tmp/var/run can be convenient. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00242">242</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

</div>
</div>
<a id="abdcd9e8b0287f914496d45a99848be44" name="abdcd9e8b0287f914496d45a99848be44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdcd9e8b0287f914496d45a99848be44">&#9670;&nbsp;</a></span>m_permissions_level_for_client_apps</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705d">util::Permissions_level</a> ipc::session::Server_app::m_permissions_level_for_client_apps</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Specifies level of access for <code><a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a></code>s (which must, also, be in <a class="el" href="structipc_1_1session_1_1Server__app.html#a12df649b33893270afeac7240a571633" title="A given Client_app (as identified by its distinct App::m_name) may request to establish an IPC sessio...">m_allowed_client_apps</a> at any rate) as enforced by file system permissions. </p>
<p >Specifically, as of this writing, it determines at least the following items. Note that ownership is identified by the UID/GID settings (matching <code>*this</code> <a class="el" href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246" title="The application must run as this user ID (UID). Files and other shared resources shall have this owne...">App::m_user_id</a> and <a class="el" href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093" title="The application must run as this group ID (GID). Files and other shared resources shall have this own...">App::m_group_id</a>) of various files and other shared resources created by the server* application in the <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> framework. (* - Actually, at times, resources are created by the client application too. See below.)</p><ul>
<li>File permissions set on the CNS (PID) file established by <a class="el" href="classipc_1_1session_1_1Session__server.html" title="To be instantiated typically once in a given process, an object of this type asynchronously listens f...">Session_server</a>. A given <a class="el" href="namespaceipc_1_1session.html#a77d8fda00e1e17f595a6a5d4c44375e7" title="A vanilla Client_session with no optional capabilities.">Client_session</a> (etc.) must read this file in order to know to which <a class="el" href="classipc_1_1session_1_1Session__server.html" title="To be instantiated typically once in a given process, an object of this type asynchronously listens f...">Session_server</a> to issue a session-open request (establish a <a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a>); if it cannot access that file, it cannot open a session against this <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a>.<ul>
<li>If this check fails, and everything is functioning as generally intended internally, then the below items are moot (as opening a session is a prerequisite for anything else).</li>
</ul>
</li>
<li>Permissions set on any SHM pool created for a given <code>"shm::*::Server_session"</code>. and <code>"shm::*::Session_server"</code>. A <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a> may not be able to complete its session-open attempt (shm::classic::Client_session::sync_connect(), etc.) if its user lacks the permissions to open the underlying SHM-pool(s) resource in the file system.(It also conceivably may be able to complete the session-open but fail if opening a pool on-demand later; the session will then likely end prematurely. This depends on the inner workings of the particular SHM system chosen; <a class="el" href="namespaceipc_1_1session_1_1shm_1_1classic.html#ac6c443a72e0f22710c83bb1e8c229618" title="This is to session::Client_session what shm::classic::Server_session is to session::Server_session.">shm::classic::Client_session</a> opens pools during session-open procedure exclusively, but other systems may behave differently.)<ul>
<li>Arena-lending SHM providers &ndash; as of this writing namely ipc::shm::arena_lend::jemalloc &ndash; involve both sides (session-server and session-client) each creating SHM pool(s) for allocations from within their respective processes. <a class="el" href="structipc_1_1session_1_1Server__app.html#abdcd9e8b0287f914496d45a99848be44" title="Specifies level of access for Client_apps (which must, also, be in m_allowed_client_apps at any rate)...">m_permissions_level_for_client_apps</a> applies to the server-created pools, yes; but also client-created pools. At the moment it seems to me (ygoldfel) that nevertheless a common setting in <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a> still makes sense. In practice, it means this: If this is set to <a class="el" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705daa3e1d310128f18fe2f903bf3cba8849a" title="Allows access by resource-owning user (in POSIX/Unix identified by UID) and no one else.">util::Permissions_level::S_USER_ACCESS</a>, then the <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a> and <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a> UID/GID shall need to be equal; if <a class="el" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705daa5508fa6037b9c0926cf7eb20af97a6d" title="Allows access by resource-owning user&#39;s containing group(s) (in POSIX/Unix identified by GID) and no ...">util::Permissions_level::S_GROUP_ACCESS</a> then just the GID (while UIDs ideally would be different).(Obviously if <code>S_UNRESTRICTED</code> then does not matter.) Don't see the sense in making this a separate knob in <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a>. Maybe though? Not a formal to-do for now.</li>
</ul>
</li>
<li>Similarly (to preceding bullet point, minus the <code>arena_lend</code> caveat) for bipc MQs. <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> opens such MQs (if so configured at compile-time) during session-open; hence on permissions failure the session-open will itself fail.</li>
<li>Similarly (to preceding bullet point) for POSIX MQs.</li>
</ul>
<p >As of this writing the list is complete; however it is conceivable it may be analogously extended to more resources. </p>
<p >That list is actually not quite complete even as of this writing. The CNS (PID) file's shared-mutex is also subject to this, as are other similar shared-mutexes (in Linux, semaphores). However that's very Inside Baseball to mention in public docs. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00288">288</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

<p class="reference">Referenced by <a class="el" href="session__server__impl_8hpp_source.html#l00439">ipc::session::Session_server_impl&lt; Session_server_t, Server_session_t &gt;::Session_server_impl()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>session/<a class="el" href="app_8hpp_source.html">app.hpp</a></li>
<li>session/<a class="el" href="session__fwd_8hpp_source.html">session_fwd.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
